Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[No QA] Update Sage Intacct Connect + Configure docs with images #52730

Merged
merged 10 commits into from
Dec 3, 2024

Conversation

johncschuster
Copy link
Contributor

@johncschuster johncschuster commented Nov 18, 2024

Explanation of Change

Fixed Issues

$ #50430
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console

Offline tests

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

  • Verify that no errors appear in the JS console

PR Author Checklist

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android / native
    • Android / Chrome
    • iOS / native
    • iOS / Safari
    • MacOS / Chrome / Safari
    • MacOS / Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

@OSBotify
Copy link
Contributor

OSBotify commented Nov 18, 2024

A preview of your ExpensifyHelp changes have been deployed to https://461c049d.helpdot.pages.dev ⚡️

@johncschuster johncschuster changed the title Update Configure-Sage-Intacct.md Update Sage Intacct Connect + Configure docs with images Nov 18, 2024
@johncschuster johncschuster marked this pull request as ready for review November 18, 2024 22:57
@johncschuster johncschuster requested a review from a team as a code owner November 18, 2024 22:57
@johncschuster johncschuster changed the title Update Sage Intacct Connect + Configure docs with images [No QA] Update Sage Intacct Connect + Configure docs with images Nov 18, 2024
@johncschuster johncschuster self-assigned this Nov 18, 2024
@melvin-bot melvin-bot bot requested review from neil-marcellini and removed request for a team November 18, 2024 22:57
Copy link

melvin-bot bot commented Nov 18, 2024

@neil-marcellini Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

Copy link
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the work. There are some rendering issues we should sort out, then it will be ready.

Comment on lines 134 to 143
1. Go to **expensify.com > Settings > Workspaces > New Workspace**.

![Image of creating a new Workspace in Expensify]({{site.url}}/assets/images/SageConnectCreatingWorkspace.png){:width="100%"}

2. Name the workspace something like "Sage Intacct Test Workspace."
3. Go to **Connections > Sage Intacct > Connect to Sage Intacct**.

![Image of selecting the Sage Intacct integration in Expensify]({{site.url}}/assets/images/SageConnectEnableSage.png){:width="100%"}

4. Select **Download Package** (You only need to download the file; we'll upload it from your Downloads folder later).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When this renders the numbering is off, it restarts after each image. You could try fixing this by indenting the images 4 spaces, or by using html tags for an ordered list. Try the indentation first. Lmk if you need help.

Google Chrome 2024-11-19 15 13 47

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The numbering is still off. I'll play around with it locally and see if I can get it fixed.

@johncschuster
Copy link
Contributor Author

Thanks, @neil-marcellini! I'll go through my urgent Concierge tasks this morning and see if I can work through your comments this afternoon.

adding 8 spaces to the images to see if that fixes the formatting
adding 8 spaces to fix the rendering of the ordered list
@johncschuster
Copy link
Contributor Author

Ok! I've just tried the 8 spaces formatting suggestion! Is it possible to regenerate the preview link?

@neil-marcellini
Copy link
Contributor

Cool. I kicked off the workflow for that, it should post here again soon.

Copy link

cloudflare-workers-and-pages bot commented Nov 22, 2024

Deploying helpdot with  Cloudflare Pages  Cloudflare Pages

Latest commit: 1542438
Status: ✅  Deploy successful!
Preview URL: https://9cfb5978.helpdot.pages.dev
Branch Preview URL: https://johncschuster-patch-4.helpdot.pages.dev

View logs

Copy link
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, so I only meant that you should indent that specific image by 8 spaces, since the content around it, a bulleted list within a bulleted list, was also indented 8 spaces.

I think images will display well in Jekyll/Markdown if they match the indentation of content around it. Since you indented some others more than necessary, that appears to be messing those up 🙈. Example below.

Since this is actually a bit tricky to get right without testing, I recommend you download the app repo to your machine and then follow the set up instructions to run the help site locally.

First steps are the clone the App repo git clone https://github.com/Expensify/App.git and then git checkout johncshuster-patch-4.. You can ask chatGPT or me for help if you get stuck. Good luck 🍀

@johncschuster
Copy link
Contributor Author

Oh darn it! I misunderstood and thought the indentations were required for all of the images 🤦

Ok, I'll go back through and clean the indents up. Thanks!

Fixing the broken indent
Fixing the broken indents
@johncschuster
Copy link
Contributor Author

Ok! I think I've understood what I did wrong and what I needed to do to fix it.

For starters, it sounds like there was one image that was broken, because it needed to be indented to match the indentation of the list it was included in. I misunderstood and indented every image. I've now un-indented the images that should never have been indented in the first place.

Fingers crossed these are the last edits 🤞

@johncschuster
Copy link
Contributor Author

@neil-marcellini can you re-run the workflow above so I can preview the changes?

@neil-marcellini
Copy link
Contributor

Cool. Sure I kicked it off here https://github.com/Expensify/App/actions/runs/12126383519

@neil-marcellini
Copy link
Contributor

Copy link
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the updates. It all looks good now except for the numbering in one of the sections. I'll work on it myself and see if I can get it working, and if not maybe I'll have it use bullet points instead.

Comment on lines 134 to 143
1. Go to **expensify.com > Settings > Workspaces > New Workspace**.

![Image of creating a new Workspace in Expensify]({{site.url}}/assets/images/SageConnectCreatingWorkspace.png){:width="100%"}

2. Name the workspace something like "Sage Intacct Test Workspace."
3. Go to **Connections > Sage Intacct > Connect to Sage Intacct**.

![Image of selecting the Sage Intacct integration in Expensify]({{site.url}}/assets/images/SageConnectEnableSage.png){:width="100%"}

4. Select **Download Package** (You only need to download the file; we'll upload it from your Downloads folder later).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The numbering is still off. I'll play around with it locally and see if I can get it fixed.

Copy link
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, I got the numbering fixed and it all looks good to me. I'll have to request another reviewer since I made a commit.

@neil-marcellini neil-marcellini requested a review from a team December 3, 2024 18:21
@melvin-bot melvin-bot bot requested review from dannymcclain and shubham1206agra and removed request for a team December 3, 2024 18:21
Copy link

melvin-bot bot commented Dec 3, 2024

@dannymcclain @shubham1206agra One of you needs to copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

@neil-marcellini neil-marcellini requested a review from a team December 3, 2024 18:24
@melvin-bot melvin-bot bot requested a review from parasharrajat December 3, 2024 18:24
Copy link

melvin-bot bot commented Dec 3, 2024

@dannymcclain @parasharrajat @ One of you needs to copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

@melvin-bot melvin-bot bot removed the request for review from a team December 3, 2024 18:24
@neil-marcellini
Copy link
Contributor

An updated preview will deploy here https://github.com/Expensify/App/actions/runs/12145891367

Copy link
Contributor

@NikkiWines NikkiWines left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

@neil-marcellini neil-marcellini merged commit bf2cc89 into main Dec 3, 2024
9 of 12 checks passed
@neil-marcellini neil-marcellini deleted the johncschuster-patch-4 branch December 3, 2024 18:31
Copy link

melvin-bot bot commented Dec 3, 2024

@neil-marcellini looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

@melvin-bot melvin-bot bot added the Emergency label Dec 3, 2024
@neil-marcellini
Copy link
Contributor

Merged with failing checklists since this is a help site change only

Copy link
Contributor

github-actions bot commented Dec 4, 2024

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 9.0.71-0 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅
🤖🔄 android HybridApp 🤖🔄 success ✅
🍎🔄 iOS HybridApp 🍎🔄 success ✅

Copy link
Contributor

github-actions bot commented Dec 5, 2024

🚀 Deployed to production by https://github.com/puneetlath in version: 9.0.71-2 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 failure ❌
🕸 web 🕸 success ✅
🤖🔄 android HybridApp 🤖🔄 failure ❌
🍎🔄 iOS HybridApp 🍎🔄 failure ❌

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants